Skip to content
/
Outcome Tracking

Outcome Tracking

Request

Update the outcome tracking fields for an existing participant using the v1 external API format.

  • Authenticated using the authorization header.
  • Validates that the API key is associated with the participant's questionnaire tenant.
  • Updates the participant's outcome and optional outcome timestamp.
Security
authorization
Path
participant_idstring, (uuid)required

UUID of the participant whose outcome tracking should be updated

Bodyapplication/jsonrequired
outcomestringrequired

Outcome code to set for the participant

Example:"$10,Reviewed and Mitigated"
outcome_tsstring, (date-time)

Outcome timestamp in RFC3339 format. If omitted, the current UTC time will be used.

Example:"2025-12-12T06:06:29Z"
curl -i -X PUT \
  'https://api.us.clearspeed.com/questionnaire/v1/participant/{participant_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "outcome": "$10,Reviewed and Mitigated",
    "outcome_ts": "2025-12-12T06:06:29Z"
  }'

Responses

Outcome tracking updated successfully

Bodyapplication/json
project_uuidstring

UUID of the project/questionnaire

Example:"fd9690b0-9050-4acd-ad74-7f906c07fe93"
phone_number1string

Primary phone number

Example:"+916263877039"
phone_number2string

Secondary phone number

Example:""
interview_ref_numstring

Interview reference number

Example:"7858934895810"
external_ref_idstring

External reference ID

Example:"12345-46b5-464d-a8e4-afecc"
participant_uuidstring

UUID of the participant

Example:"01977df0-57c1-7dcf-8916-df741aa66691"
emailstring

Email address

Example:"participant@gmail.com"
languagestring

Participant language

Example:"English"
is_participant_allowedboolean

Whether participant is allowed after call-blocking checks

Example:true
outcomestring or null

Outcome code for the participant

Example:"$10,Reviewed and Mitigated"
outcome_tsstring or null, (date-time)

Outcome timestamp in RFC3339 format

Example:"2025-12-12T06:06:29Z"
Response
{
  "project_uuid": "fd9690b0-9050-4acd-ad74-7f906c07fe93",
  "phone_number1": "+916263877039",
  "phone_number2": "",
  "interview_ref_num": "7858934895810",
  "external_ref_id": "12345-46b5-464d-a8e4-afecc",
  "participant_uuid": "01977df0-57c1-7dcf-8916-df741aa66691",
  "email": "participant@gmail.com",
  "language": "English",
  "particpant_guide_link": "https://guide.example.com?id=01977df0-57c1-7dcf-8916-df741aa66691",
  "is_participant_allowed": true,
  "outcome": "$10,Reviewed and Mitigated",
  "outcome_ts": "2025-12-12T06:06:29Z"
}